home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2001 May / SGI Freeware 2001 May - Disc 3.iso / dist / fw_apache.idb / usr / freeware / apache / include / ap_mm.h.z / ap_mm.h
C/C++ Source or Header  |  2001-01-10  |  6KB  |  131 lines
  1. /* ====================================================================
  2.  * Copyright (c) 1999-2000 The Apache Group.  All rights reserved.
  3.  *
  4.  * Redistribution and use in source and binary forms, with or without
  5.  * modification, are permitted provided that the following conditions
  6.  * are met:
  7.  *
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer. 
  10.  *
  11.  * 2. Redistributions in binary form must reproduce the above copyright
  12.  *    notice, this list of conditions and the following disclaimer in
  13.  *    the documentation and/or other materials provided with the
  14.  *    distribution.
  15.  *
  16.  * 3. All advertising materials mentioning features or use of this
  17.  *    software must display the following acknowledgment:
  18.  *    "This product includes software developed by the Apache Group
  19.  *    for use in the Apache HTTP server project (http://www.apache.org/)."
  20.  *
  21.  * 4. The names "Apache Server" and "Apache Group" must not be used to
  22.  *    endorse or promote products derived from this software without
  23.  *    prior written permission. For written permission, please contact
  24.  *    apache@apache.org.
  25.  *
  26.  * 5. Products derived from this software may not be called "Apache"
  27.  *    nor may "Apache" appear in their names without prior written
  28.  *    permission of the Apache Group.
  29.  *
  30.  * 6. Redistributions of any form whatsoever must retain the following
  31.  *    acknowledgment:
  32.  *    "This product includes software developed by the Apache Group
  33.  *    for use in the Apache HTTP server project (http://www.apache.org/)."
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
  36.  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38.  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE APACHE GROUP OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  42.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  44.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  46.  * OF THE POSSIBILITY OF SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Group and was originally based
  51.  * on public domain software written at the National Center for
  52.  * Supercomputing Applications, University of Illinois, Urbana-Champaign.
  53.  * For more information on the Apache Group and the Apache HTTP server
  54.  * project, please see <http://www.apache.org/>.
  55.  */
  56.  
  57. /*
  58. **
  59. ** ap_mm.h -- wrapper code for MM shared memory library
  60. **
  61. */
  62.  
  63. #ifdef EAPI
  64.  
  65. #ifndef AP_MM_H 
  66. #define AP_MM_H 1
  67.  
  68. #ifndef FALSE
  69. #define FALSE 0
  70. #define TRUE  !FALSE
  71. #endif
  72.  
  73. API_EXPORT(int) ap_mm_useable(void);
  74.  
  75. typedef void AP_MM;
  76. typedef enum { AP_MM_LOCK_RD, AP_MM_LOCK_RW } ap_mm_lock_mode;
  77.  
  78. /* Global Malloc-Replacement API */
  79. API_EXPORT(int)     ap_MM_create(size_t size, char *file);
  80. API_EXPORT(int)     ap_MM_permission(mode_t mode, uid_t owner, gid_t group);
  81. API_EXPORT(void)    ap_MM_destroy(void);
  82. API_EXPORT(int)     ap_MM_lock(ap_mm_lock_mode mode);
  83. API_EXPORT(int)     ap_MM_unlock(void);
  84. API_EXPORT(void *)  ap_MM_malloc(size_t size);
  85. API_EXPORT(void *)  ap_MM_realloc(void *ptr, size_t size);
  86. API_EXPORT(void)    ap_MM_free(void *ptr);
  87. API_EXPORT(void *)  ap_MM_calloc(size_t number, size_t size);
  88. API_EXPORT(char *)  ap_MM_strdup(const char *str);
  89. API_EXPORT(size_t)  ap_MM_sizeof(void *ptr);
  90. API_EXPORT(size_t)  ap_MM_maxsize(void);
  91. API_EXPORT(size_t)  ap_MM_available(void);
  92. API_EXPORT(char *)  ap_MM_error(void);
  93.  
  94. /* Standard Malloc-Style API */
  95. API_EXPORT(AP_MM *) ap_mm_create(size_t size, char *file);
  96. API_EXPORT(int)     ap_mm_permission(AP_MM *mm, mode_t mode, uid_t owner, gid_t group);
  97. API_EXPORT(void)    ap_mm_destroy(AP_MM *mm);
  98. API_EXPORT(int)     ap_mm_lock(AP_MM *mm, ap_mm_lock_mode mode);
  99. API_EXPORT(int)     ap_mm_unlock(AP_MM *mm);
  100. API_EXPORT(void *)  ap_mm_malloc(AP_MM *mm, size_t size);
  101. API_EXPORT(void *)  ap_mm_realloc(AP_MM *mm, void *ptr, size_t size);
  102. API_EXPORT(void)    ap_mm_free(AP_MM *mm, void *ptr);
  103. API_EXPORT(void *)  ap_mm_calloc(AP_MM *mm, size_t number, size_t size);
  104. API_EXPORT(char *)  ap_mm_strdup(AP_MM *mm, const char *str);
  105. API_EXPORT(size_t)  ap_mm_sizeof(AP_MM *mm, void *ptr);
  106. API_EXPORT(size_t)  ap_mm_maxsize(void);
  107. API_EXPORT(size_t)  ap_mm_available(AP_MM *mm);
  108. API_EXPORT(char *)  ap_mm_error(void);
  109. API_EXPORT(void)    ap_mm_display_info(AP_MM *mm);
  110.  
  111. /* Low-Level Shared Memory API */
  112. API_EXPORT(void *)  ap_mm_core_create(size_t size, char *file);
  113. API_EXPORT(int)     ap_mm_core_permission(void *core, mode_t mode, uid_t owner, gid_t group);
  114. API_EXPORT(void)    ap_mm_core_delete(void *core);
  115. API_EXPORT(size_t)  ap_mm_core_size(void *core);
  116. API_EXPORT(int)     ap_mm_core_lock(void *core, ap_mm_lock_mode mode);
  117. API_EXPORT(int)     ap_mm_core_unlock(void *core);
  118. API_EXPORT(size_t)  ap_mm_core_maxsegsize(void);
  119. API_EXPORT(size_t)  ap_mm_core_align2page(size_t size);
  120. API_EXPORT(size_t)  ap_mm_core_align2word(size_t size);
  121.  
  122. /* Internal Library API */
  123. API_EXPORT(void)    ap_mm_lib_error_set(unsigned int, const char *str);
  124. API_EXPORT(char *)  ap_mm_lib_error_get(void);
  125. API_EXPORT(int)     ap_mm_lib_version(void);
  126.  
  127. #endif /* AP_MM_H */
  128.  
  129. #endif /* EAPI */
  130.  
  131.